The PhysicalPieceObserver script is a script that can be added onto GameObjects that you would like physical pieces to pair with and control the movement of.

The PhysicalPieceObserver script requires the Gameboard GameObject to be present. Find the Gameboard menu at the top of the unity header and click "Add SDK" to add the Gameboard GameObject to your project. If you do not have the Gameboard menu options, see Gameboard SDK Access

First, select all the GameObjects you would like to attach the PhysicalPieceObserver script to.

Next, find the Gameboard menu at the top of the unity header and click "Add Physical Piece Observer" to add the PhysicalPieceObserver to your GameObject(s).

This will add a the script to the gameobjects, and you will see a red gizmo indicating the pairing radius, and what on the gameobject is considered "forward".

Now that GameObject is able to quickly be paired with physical gameboard tokens!

You will notice the Physical Piece Observer Script has a few customizable options.

Property Descriptions

Standard Options

• Radius: How large of an area around the GameObject would trigger pairing if a physical piece moved within this area. The area is also shown by the gizmo.
• AutoPair: When checked, the physical piece will automatically pair with the gameobject if within the radius (and not already paired to another gameobject, unless Allow Pair Overriding is check)
• Allow Pair Overriding: When checked, pieces can override existing pairings when within the radius of the gameobject. This option would allow for the following situations to be overridden (losing their initial pairings, and repairing. Pairing will never be denied):
  • An unpaired piece is within pairing range of a paired GameObject
  • An paired piece is within pairing range of an unpaired GameObject
• Auto Control: When checked, the GameObject's position on the screen will be auto updated to the location of the physcial piece on the board.

World View Options

If the game object is in the world space, as opposed to the child of a canvas, you will want to set these options as well.

• World View Camera: Camera that is displaying on the Gameboard, so what view would correspond to the full physical gameboard screen.
• Distance From Camera: How far you want the GameObject to appear from the specified camera within the space that corresponds to the physical token on the screen. Uses Camera.main if nothing is specified.

Other Options

• Character Controller: Optional character controller that would use the Move method when the physical piece is moved with auto control on.
• Gizmo Color: Color of gizmo that shows to help debug pairing radius and gameobject direction.

There are various events that you can use to keep track of physical token pairing and paired token locations:

OnPieceAvailableForPairing

Properties: GameboardShape piece, bool tokenAlreadyPaired, bool currentlyPairedToToken

• If autopair is off, this event will be triggered when a physical token is within the pairing radius of the GameObject. You will receive the GameboardShape that describes the physical piece, and two flags idicating if the token is already paired, or if the gameobject is already paired to a token.

OnPieceAutoPairingDenied

Properties: GameboardShape piece, List reasons

• If autopair is on, and allowPairOverriding is off, this will be triggered anytime a piece is within pairing radius of a piece that it can't pair with for various reasons. You will get a list of enums describing the reason the token and GameObject was denied pairing.

OnPiecePaired

Properties: GameboardShape piece

• This is called anytime a physical token is paired to a GameObject.

OnPieceUnpaired

Properties: GameboardShape piece

• This is called anytime a physical token is unpaired from a GameObject.

OnPieceTransformChanged

Properties: GameboardShape piece

• This is called anytime the paired physical token's location changes.

You can manually pair or unpair tokens as well.

To pair a GameboardShape, you can call pairPiece with an optional flag to overridePairing. Say you get a GameboardShape from the OnPieceAvailableForPairing event, and you decide you do want to pair this GameObject with that physical GameboardShape. And you notice that token is already paired, but you displayed an alert asking if the user wants to continue and they clicked yes, so you want to proceed with the pairing.

objPieceObserver.pairPiece(shape, true);

and to remove a pairing simple call unpairPiece on the piece observer.

objPieceObserver.unpairPiece();

You can also see all the paired pieces by shapeId on the TouchController in the pairedPieces dictionary. This pairs the GameboardShape based on their shapeId to the PhyscialPieceObserver they are currently paired with.